Skip to content

feat(sveltekit): Mark pageloads of prerendered pages - #26307

Merged
s1gr1d merged 8 commits into
developfrom
sig/sveltekit-vercel-isr
Nov 13, 2026
Merged

s1gr1d merged 8 commits into
developfrom
sig/sveltekit-vercel-isr

Conversation

@s1gr1d

@s1gr1d s1gr1d commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Stacked on #26301.

Why: Vercel ISR (config.isr) caches the HTML of one request and serves it to every visitor until it expires. That HTML holds the live sentry-trace and baggage tags of the render, so every visitor continued the same old server trace. Next.js had the same bug, fixed in #25141. Now a page that Vercel renders for its ISR cache gets a sentry-cache-origin tag with the render's sentry-trace in place of the trace tags. The pageload starts its own trace, gets page.server_rendering.type: static, and links the render with a cache_origin link, as in Next.js (#25318).

To detect an ISR render, sentryHandle reads the x-vercel-isr request header. Vercel sends it to every invocation of an ISR function, also for background revalidations and for routes that get config.isr from a layout. The adapter's own __pathname marker is gone before Kit sees the request, and handle cannot see the route config (tested both on a Vercel deployment).

Like a use cache hit, the pageload links only a sampled render. An unsampled render still marks the pageload as static. A page with ssr = false gets no tags, as in the build.

How to review: Start with getCacheOrigin in handle.ts. It returns the render's trace (ISR), '' (build) or undefined (rendered for this request only). Then withCacheOrigin in client/traceMetaTags.ts. The two browser-tracing variants only wrap their existing span options.

Unsure about: A client can send x-vercel-isr to a normal SSR route, and the function sees it. That only changes the pageload of the request that sends it: it links its own server request instead of continuing it. I think that is acceptable. I did not check draft mode (bypassToken), where Vercel does not cache the render.

Example with the UI changes from getsentry/sentry#130771 (a visitor that got an already happened ISR render):
image

https://sentry-4x3dkn58u.sentry.dev/explore/traces/trace/63b1dbe5fe3849f2b13df81530857c03/

Linear: JSSDK-37

@s1gr1d
s1gr1d requested review from a team, JPeer264 and msonnb November 11, 2026 15:45
@s1gr1d
s1gr1d requested a review from a team as a code owner November 11, 2026 15:45
@s1gr1d
s1gr1d requested a review from chargome November 11, 2026 15:48
@s1gr1d

s1gr1d commented Nov 11, 2026

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

return getTraceMetaTags();
}
return isServerRenderedPage(html) ? `<meta name="${CACHE_ORIGIN_META_TAG_NAME}" content=""/>` : '';
return isServerRenderedPage(html) ? `<meta name="${CACHE_ORIGIN_META_TAG_NAME}" content="${cacheOrigin}"/>` : '';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does a '' cache origin mean? 🤔 I wonder if we can simplify this a bit, I always find it a bit hard to follow if something can deliberately return '' or undefined 🤔

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. The empty value means "the page was rendered earlier, but we cannot link to it" (e.g. because it happened during build time). I'm gonna make that more clear.

…el-isr

# Conflicts:
#	CHANGELOG.md
#	dev-packages/e2e-tests/test-applications/sveltekit-2-static/tests/sdk.test.ts
#	dev-packages/e2e-tests/test-applications/sveltekit-3/tests/prerender.test.ts
#	packages/sveltekit/src/client/svelte4BrowserTracing.ts
#	packages/sveltekit/src/client/svelte5BrowserTracing.ts
#	packages/sveltekit/src/client/traceMetaTags.ts
#	packages/sveltekit/src/common/traceMetaTags.ts
#	packages/sveltekit/src/server-common/handle.ts
#	packages/sveltekit/test/client/browserTracingIntegration.test.ts
#	packages/sveltekit/test/client/svelte5BrowserTracing.test.ts
@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

Compared: 1f5a46f (PR test merge using develop at 88cc648)

Against: 88cc648 (develop) · base run #66002

✅ Baseline matches: this diff contains only this PR's changes.

Path Size % Change Change
@sentry/browser 30.1 kB - -
@sentry/browser - with treeshaking flags 28.3 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 28.2 kB - -
@sentry/browser (incl. Tracing) 52.28 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.29 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.25 kB - -
@sentry/browser (incl. Tracing, Replay) 92.82 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 81.6 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 97.21 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 110.6 kB - -
@sentry/browser (incl. Feedback) 47.73 kB - -
@sentry/browser (incl. sendFeedback) 30.69 kB - -
@sentry/browser (incl. FeedbackAsync) 35.69 kB - -
@sentry/browser (incl. Metrics) 31.43 kB - -
@sentry/browser (incl. Logs) 31.71 kB - -
@sentry/browser (incl. Metrics & Logs) 32.37 kB - -
@sentry/react 32.11 kB - -
@sentry/react (incl. Tracing) 54.95 kB - -
@sentry/vue 38.3 kB - -
@sentry/vue (incl. Tracing) 55.24 kB - -
@sentry/svelte 30.12 kB - -
@sentry/remix (Remix 3 client bundle) 58.06 kB - -
CDN Bundle 31.87 kB - -
CDN Bundle (incl. Tracing) 52.7 kB - -
CDN Bundle (incl. Logs, Metrics) 34.67 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 55.26 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 75.7 kB - -
CDN Bundle (incl. Tracing, Replay) 90.72 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 93.33 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 96.09 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 98.69 kB - -
CDN Bundle - uncompressed 92.98 kB - -
CDN Bundle (incl. Tracing) - uncompressed 155.45 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 101.33 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 163.08 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 231.43 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 275.6 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 283.23 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 287.39 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 295.01 kB - -
@sentry/nextjs (client) 58.34 kB - -
@sentry/sveltekit (client) 53.46 kB +0.19% +99 B 🔺
@sentry/core/server 44.57 kB - -
@sentry/core/browser 13.99 kB - -
@sentry/node 149.54 kB -0.01% -5 B 🔽
@sentry/node/import (ESM hook with diagnostics-channel injection) 83.3 kB - -
@sentry/node - without tracing 88.47 kB -0.01% -7 B 🔽
@sentry/node - without channel injection 138.5 kB -0.01% -3 B 🔽
@sentry/aws-serverless 97.39 kB -0.01% -8 B 🔽
@sentry/cloudflare (withSentry) - minified 204.55 kB - -
@sentry/cloudflare (withSentry) 474.76 kB - -
@sentry/nextjs/cloudflare (withSentry) - minified 229.86 kB - -

View base workflow run

@s1gr1d
s1gr1d requested a review from mydea November 13, 2026 10:29
@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Optional E2E tests

Some optional checks were not successful. They do not block the merge. 4 not successful, 45 successful. See the run.

Check Status
❌ CI: Optional E2E Tests / E2E node-eve (orchestrion) Test (optional) Failing after 2m Details
❌ CI: Optional E2E Tests / E2E node-eve (latest) Test (optional) Failing after 2m Details
❌ CI: Optional E2E Tests / E2E nextjs-16-cacheComponents (cloudflare) Test (optional) Failing after 10m Details
❌ CI: Optional E2E Tests / E2E node-eve Test (optional) Failing after 2m Details
Successful checks
Check Status
✅ CI: Optional E2E Tests / E2E nestjs-12 (cloudflare) Test (optional) Successful in 30s Details
✅ CI: Optional E2E Tests / E2E nextjs-orpc Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (bun) Test (optional) Successful in 53s Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (latest) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v1 Test (optional) Successful in 25s Details
✅ CI: Optional E2E Tests / E2E nextjs-16-tunnel (cloudflare) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (static / nuxt generate) Test (optional) Successful in 36s Details
✅ CI: Optional E2E Tests / E2E supabase-nextjs Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries Test (optional) Successful in 57s Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-sourcemaps Test (optional) Successful in 37s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (cloudflare, latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry Test (optional) Successful in 58s Details
✅ CI: Optional E2E Tests / E2E astro-7 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-mastra (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-cloudflare Test (optional) Successful in 37s Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (latest) Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E node-mastra Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (deno) Test (optional) Successful in 59s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-cloudflare Test (optional) Successful in 26s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext, bun) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (latest) Test (optional) Successful in 52s Details
✅ CI: Optional E2E Tests / E2E node-flue (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps Test (optional) Successful in 34s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (kv-cache) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (cloudflare) Test (optional) Successful in 42s Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 Test (optional) Successful in 36s Details
✅ CI: Optional E2E Tests / E2E node-pi-durable (latest) Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions (latest) Test (optional) Successful in 30s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (client source maps kept) Test (optional) Successful in 42s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions Test (optional) Successful in 31s Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 (tracer provider) Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (turbo) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-pi-durable Test (optional) Successful in 36s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E react-router-7-framework-instrumentation Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E solidstart-2 Test (optional) Successful in 55s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (tunnel-dev) Test (optional) Successful in 58s Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v2 Test (optional) Successful in 28s Details
✅ CI: Optional E2E Tests / E2E node-flue Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E debug-id-sourcemaps Test (optional) Successful in 42s Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E astro-7-static Test (optional) Successful in 1m Details

@s1gr1d

s1gr1d commented Nov 13, 2026

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit e91fb79. Configure here.

Comment thread pnpm-lock.yaml Resolved
pageloadSpanPromise,
]);

expect(originSpan.trace_id).toBe(originTraceId);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we additionally check that expect(getSpanOp(originSpan)).toBe('http.server') here? SInce we do not control the spans from sveltekit this would verify that actually attach it to the segment/root span

With Kit tracing, the active span during the render is Kit's `sveltekit.resolve`, so the cache origin pointed at it instead of the request's root span. Also removes an unrelated `@pnpm/exe` lockfile entry.
@s1gr1d
s1gr1d requested a review from chargome November 13, 2026 12:47

@chargome chargome left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@s1gr1d
s1gr1d merged commit 239efed into develop Nov 13, 2026
339 of 343 checks passed
@s1gr1d
s1gr1d deleted the sig/sveltekit-vercel-isr branch November 13, 2026 13:01
s1gr1d added a commit that referenced this pull request Nov 13, 2026
…26363)

## What

Next.js, Nuxt and SvelteKit now use one shared implementation of the
`sentry-cache-origin` tag from #25318, #26305 and #26307. There is no
change for users.

- `@sentry/core` holds the tag name, the server code that writes the
tag, and the client code that marks and links the pageload. All of these
are `_INTERNAL_` exports. The client part is in `@sentry/core/browser`,
and the server part is in `@sentry/core/server`.
- Nuxt now links the request's root span explicitly, like SvelteKit. The
Nuxt E2E tests check that the tag holds the `http.server` root span.

## Why

Each SDK had its own copy of the tag name, the tag writer and the
pageload logic. With one module, the server writer and the client reader
cannot drift apart. A round-trip test now checks that the client reads
the tag the server writes.

Each framework keeps its own decision about which page is reused (build,
`x-vercel-isr`, Nitro route rules, Next.js prerender context). Those
rules differ per framework, so a shared helper would only pass them
through.

The Nuxt change already behaves the same today: no child span is active
while Nuxt renders the page. The explicit root span protects the link
from a future child span. That is the bug SvelteKit had with
`sveltekit.resolve`.

Two edge cases are now handled the same way in all three SDKs, and the
SDKs never write either one:

- An empty tag marks the pageload without a link. Before this change,
only Next.js ignored an empty tag, and Next.js never writes one.
- Core reads the first tag. Before this change, Next.js read the last
one, but a Next.js document never has more than one tag.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants